You are here:

Create a new Data Source

{ createDataServer }

Adds a new data source server to the system.

Method

/API3/dataSources/createDataServer

API Section: /API3/dataSources

API Version: 3.0

From Release: 2023.10

Usage: REST API and Client SDK libraries. REST APIs via POST actions only.

Usage by:

Enterprise Admin

Input Parameters

Name

serverData

Object Type

ServerData

Description

The data source server object and its settings.

Output Response

Successful Result Code

200

Response Type

ModifiedItemsResult

Description of Response Type

Generic API response object with success or failure flag and related messages.

Notes

Data sources represent data servers that can be queried.

Examples

Data Source Operations (JavaScript):

This example demonstrates how to operate with data sources.

The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";

// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
	"userName":"adminUser",
	"password":"12345678"
},"",false);
log("got token "+token);

// step 2: find roles in the system
let findRole = callApi("access/findRoles",{
	"searchValue": "role1",
	"searchMatchType": 2//SearchMatchType.Equals
},token // admin token generated above
);
let roleId=findRole.data[0].roleId;
log("found role with id= "+ roleId);

// step 3: add a new data source server (IMDB)
let createDataServer = callApi("dataSources/createDataServer",{
	"serverName": "new server",
	"serverType":13,// use the server type enumeration. 13 = IMDB
	"serverIp": "172.29.3.178",
	"port":5060,
	"serverAuthenticationMethod":0,//ServerAuthenticationMethod.UserPassword
	"userName":"default",
	"password":"password",
},token // admin token generated above
);
let dataServerId=createDataServer.data.modifiedList[0].id;
log("created dataserver= "+ dataServerId);

// step 4: secure server from step 3 with roles
let addRolesToServer = callApi("dataSources/addRolesToServer",{
	"itemId":dataServerId,
	"itemRolePairList":[{
		"roleId":roleId,
		"accessType":2//AccessType.Read
	}]
},token);
log("added role1 to the newly created server");

// step 5: optional: check the roels on the server
let getRolesByServer= callApi("dataSources/getRolesByServer",dataServerId,token);

// step 6: recognize an existing database on the server
//use this method when you want to address the database in Pyramid
let recognizeDataBase = callApi("dataSources/recognizeDataBase",{
	"serverId":dataServerId, //this comes from step 3 above
	"dbName":"PyramidDemo"
},token);
let databaseId=recognizeDataBase.data.modifiedList[0].id;
log("found database "+databaseId+" at the dataserver");

// step 7: secure the database from step 3 with roles
let addRolesToDataBase = callApi("dataSources/addRolesToDataBase",{
	"itemId":databaseId,
	"itemRolePairList":[{
		"roleId":roleId,
		"accessType":3//AccessType.Write
	}]
},token);

// step 8A: read in an existing data model from a PIE file
let file="http://myOtherSite.com/SampleModel.pie";
let modelData=readPieFile(file);

// step 8B: import the file content into Pyramid
let importModel = callApi("dataSources/importModel",{
	"fileZippedData":modelData, //model data from step 8A
	"databaseId":databaseId, //from step 6
	"materializedRoleAssignmentType":3//MaterializedRoleAssignmentType.ForceParentRoles
},token).data;


// step 9: secure the model from step 3 with roles
let addRolesToModel = callApi("dataSources/addRolesToModel",{
	"itemId":importModel.modelId, //from step 8B
	"itemRolePairList":[{
		"roleId":roleId,
		"accessType":3//AccessType.Write
	}]
},token);

//step 10: delete the model
let deleteMaterializedModel = callApi("dataSources/deleteMaterializedModel",importModel.modelId,token);


//step 11: delete the database
let deleteDataBase=callApi("dataSources/deleteDataBase",databaseId,token);

//step 12: delete the dta source (server)
let deleteDataSource = callApi("dataSources/deleteDataSource",dataServerId,token);

function log(msg){
	document.write(msg);
	console.log(msg);
}

// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
	var xhttp = new XMLHttpRequest();
	xhttp.open("POST", pyramidURL+path, false);
	xhttp.setRequestHeader("paToken",token)
	xhttp.send(JSON.stringify(data));
	if(parseResult){
		return JSON.parse(xhttp.responseText);
	}else{
		return xhttp.responseText;
	}
}

//example function to read in the contents of a 'PIE' file that contains
//exported Pyramid content.
function readPieFile(file){
	var rawFile = new XMLHttpRequest();
	rawFile.open("GET", file, false);
	rawFile.send(null);
	rawFile.onreadystatechange = function () {
		if (request.readyState === 4 && request.status === 200) {
			return request.responseText;
        }
    }
}

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript

Curl

Java

Python

PHP

curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/dataSources/createDataServer" \
 -d '{
  "instanceName" : "instanceName",
  "overlayPyramidSecurity" : true,
  "useGlobalAccount" : true,
  "serverName" : "serverName",
  "description" : "description",
  "securedByUser" : true,
  "userName" : "userName",
  "writeCapable" : 0,
  "password" : "password",
  "defaultDatabaseName" : "defaultDatabaseName",
  "port" : 6,
  "pulseClient" : "pulseClient",
  "tenantId" : "tenantId",
  "modifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "serverIp" : "serverIp",
  "id" : "id",
  "additionalServerProperties" : {
    "customTrustStore" : "customTrustStore",
    "disableDBTables" : true,
    "defaultTrustStorePassword" : "defaultTrustStorePassword",
    "salesforceSecurityToken" : "salesforceSecurityToken",
    "krbServiceName" : "krbServiceName",
    "disableAnalyticViews" : true,
    "bwSupportStructures" : true,
    "messageServerHost" : "messageServerHost",
    "ftpSettings" : {
      "isRequireReuseTLS" : true,
      "portRangeMin" : 1,
      "portRangeMax" : 5
    },
    "customKeyStoreType" : "customKeyStoreType",
    "sharedFolderPath" : "sharedFolderPath",
    "showInfoAreaTree" : true,
    "shouldValidateServerCertHostname" : true,
    "hdfsPort" : 5,
    "hdfsIP" : "hdfsIP",
    "mdxCompatibility" : 2,
    "keytabPath" : "keytabPath",
    "s3StagingDir" : "s3StagingDir",
    "systemR3Name" : "systemR3Name",
    "customJdbcId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sysNumber" : "sysNumber",
    "bringNonOleDbComponents" : true,
    "messageServerService" : "messageServerService",
    "quotaProjectId" : "quotaProjectId",
    "useClientCertificate" : true,
    "isCustomTrustStore" : true,
    "awsBucketName" : "awsBucketName",
    "customJdbcProps" : {
      "key" : "customJdbcProps"
    },
    "clientKeyPath" : "clientKeyPath",
    "warehouse" : "warehouse",
    "accessToken" : "accessToken",
    "customTrustStorePassword" : "customTrustStorePassword",
    "isOperatingSystemTrustStore" : true,
    "isDatabaseSchema" : true,
    "useSSL" : true,
    "accountId" : "accountId",
    "odbcDirectQueryOptions" : { },
    "avoidMultiPassAuthentication" : true,
    "urlPortal" : "urlPortal",
    "privateCertId" : "privateCertId",
    "supportsBwFlatQueries" : true,
    "shouldValidateServerCert" : true,
    "sapRouter" : "sapRouter",
    "timezone" : "timezone",
    "disableCalculationViews" : true,
    "sncPartnerName" : "sncPartnerName",
    "groupServer" : "groupServer",
    "isOverrideConnectionString" : true,
    "consumerSecret" : "consumerSecret",
    "isCustomKeyStore" : true,
    "customTrustStoreType" : "customTrustStoreType",
    "azureTabular" : true,
    "disableAttributeViews" : true,
    "customCertHostname" : "customCertHostname",
    "consumerKey" : "consumerKey",
    "clientCertPath" : "clientCertPath",
    "awsSecretAccessKey" : "awsSecretAccessKey",
    "isCustomCertHostname" : true,
    "oauthDataSourceSettings" : {
      "redirectUri" : "redirectUri",
      "clientId" : "clientId",
      "loadSuperFromGlobal" : true,
      "scope" : "scope",
      "jwksUri" : "jwksUri",
      "clientSecret" : "clientSecret",
      "tokenEntryPoint" : "tokenEntryPoint",
      "authenticationEndPointUrl" : "authenticationEndPointUrl",
      "inheritanceType" : "OauthDataSourceSettings"
    },
    "hiveIP" : "hiveIP",
    "defaultCulture" : "defaultCulture",
    "awsRegion" : "awsRegion",
    "bwInfoAreaIconIds" : "bwInfoAreaIconIds",
    "useCustomCertificateConfig" : true,
    "awsAccessKeyId" : "awsAccessKeyId",
    "roleId" : "roleId",
    "hivePort" : 7,
    "clientNumber" : "clientNumber",
    "keytabId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "accessTokenSecret" : "accessTokenSecret",
    "relativeFolderName" : "relativeFolderName",
    "customKeyStore" : "customKeyStore",
    "clientKeyPassword" : "clientKeyPassword",
    "customKeyStorePassword" : "customKeyStorePassword",
    "resolveColumnLabel" : true,
    "machineAccountFallback" : true,
    "customRootCaCert" : "customRootCaCert"
  },
  "displayFolder" : "displayFolder",
  "optionalParameters" : "optionalParameters"
}'

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;

import java.util.*;
import java.time.*;

public class DataSourcesServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
        // Initialize the serverData parameter object for the call
        ServerData serverData = ; // Create the input object for the operation, type: ServerData 

        try {
            ModifiedItemsResult result = apiInstance.createDataServer(serverData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourcesServiceApi#createDataServer");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const serverData = ; // {ServerData} 

api.createDataServer(serverData).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class createDataServerExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new DataSourcesServiceApi();
        // Initialize the serverData parameter object for the call
        var serverData = new ServerData(); // ServerData | 

        try {
            // Adds a new data source server to the system.
            ModifiedItemsResult result = apiInstance.createDataServer(serverData);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling DataSourcesServiceApi.createDataServer: " + e.Message );
        }
    }
}

import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = DataSourcesServiceApi(api_client)
    # Initialize the serverData parameter object for the call
    serverData =  # ServerData | 

    try:
        # Adds a new data source server to the system.
        api_response = api_instance.create_data_server(serverData)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataSourcesServiceApi->createDataServer: %s\n" % e)

<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
$serverData = ; // ServerData | 

try {
    $result = $api_instance->createDataServer($serverData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataSourcesServiceApi->createDataServer: ', $e->getMessage(), PHP_EOL;
}
?>

Feedback

Couldn't find what I was looking for

Help was confusing, unclear or incomplete

Instructions didn't work